Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update testing-how-to.md #2839

Merged
merged 12 commits into from
Nov 20, 2024
Merged

Update testing-how-to.md #2839

merged 12 commits into from
Nov 20, 2024

Conversation

AmberAlston
Copy link
Member

No description provided.

Copy link

netlify bot commented Nov 19, 2024

Deploy Preview for replicated-docs ready!

Name Link
🔨 Latest commit d54ca90
🔍 Latest deploy log https://app.netlify.com/sites/replicated-docs/deploys/673d3c80064b860008e3a317
😎 Deploy Preview https://deploy-preview-2839--replicated-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

netlify bot commented Nov 19, 2024

Deploy Preview for replicated-docs-upgrade ready!

Name Link
🔨 Latest commit d54ca90
🔍 Latest deploy log https://app.netlify.com/sites/replicated-docs-upgrade/deploys/673d3c806664980008d2df20
😎 Deploy Preview https://deploy-preview-2839--replicated-docs-upgrade.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@replicated-ci replicated-ci added type::docs Improvements or additions to documentation type::feature labels Nov 19, 2024
@AmberAlston AmberAlston marked this pull request as ready for review November 19, 2024 22:45
@AmberAlston AmberAlston requested a review from a team as a code owner November 19, 2024 22:45
jdewinne
jdewinne previously approved these changes Nov 19, 2024
@@ -42,9 +42,12 @@ To create a cluster using the Replicated CLI:
Where:
* `NAME` is any name for the cluster. If `--name` is excluded, a name is automatically generated for the cluster.
* `K8S_DISTRO` is the Kubernetes distribution for the cluster.
* `K8S_VERSION` is the Kubernetes version for the cluster.
* `K8S_VERSION` is the Kubernetes version for the cluster if creating a standard Cloud or VM based cluster.
* When creating an Embedded Cluster type using `cluster create`, use of `--version` is optional, and the value passed should be the `Channel release sequence` value if not using "latest"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't this going to result in people actually trying --version latest for EC? Which will not work, as it should be a channel sequence number.

@@ -267,7 +267,7 @@ Compatibility Matrix supports creating [kURL](https://kurl.sh) clusters.
</tr>
<tr>
<th>Supported kURL Versions</th>
<td>Any promoted kURL installer. For an installer version other than "latest", you can find the ID for previously promoted installers on the **Channels > kURL Installer History** page in the Vendor Portal. For more information about viewing the history of kURL installers promoted to a channel, see [Installer History](/vendor/installer-history).</td>
<td>Any promoted kURL installer. Version is optional. For an installer version other than "latest", you can find the ID for previously promoted installers on the **Channels > kURL Installer History** page in the Vendor Portal. For more information about viewing the history of kURL installers promoted to a channel, see [Installer History](/vendor/installer-history).</td>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we clarify it needs to be the slug, and not the sequence number for kURL?

@@ -37,14 +37,17 @@ To create a cluster using the Replicated CLI:
1. Run the following command to create a cluster:

```
replicated cluster create --name NAME --distribution K8S_DISTRO --version K8S_VERSION --disk DISK_SIZE --instance-type INSTANCE_TYPE
replicated cluster create --name NAME --distribution K8S_DISTRO --version K8S_VERSION --disk DISK_SIZE --instance-type INSTANCE_TYPE [--license-id LICENSE_ID]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

^ wrapped in brackets to indicate optionality

@AmberAlston AmberAlston merged commit 1995f4f into main Nov 20, 2024
5 checks passed
@AmberAlston AmberAlston deleted the AmberAlston-patch-1 branch November 20, 2024 16:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type::docs Improvements or additions to documentation type::feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants